<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
	<head>
		<title>Tuxxedo Engine API Documentation</title>

		<link rel="stylesheet" href="./style.css" media="all" type="text/css" />
	</head>
	<body>

<h1>\Tuxxedo\Helper\Database</h1>
<div class="box">
	<div class="inner">
		<div class="left-content">
			<fieldset>
				<legend><strong>Meta information</strong></legend>
				<table cellspacing="4" cellpadding="0">
					<tr>
						<td>Availability:</td>
						<td class="value" style="width: 100%">
							Engine 1.0.0
						</td>
					</tr>
					<tr>
						<td>Type:</td>
						<td class="value" style="width: 100%">
							<a href="./classes.html">Class</a>
						</td>
					</tr>
					<tr>
	<td nowrap="nowrap">Namespace:</td>
	<td class="value" style="width: 100%" nowrap="nowrap">
		<a href="namespace-tuxxedo-helper-467151.html">\Tuxxedo\Helper</a>
	</td>
</tr><tr>
	<td nowrap="nowrap">Declared in:</td>
	<td class="value" style="width: 100%" nowrap="nowrap">
		library/Tuxxedo/Helper/Database.php
	</td>
</tr>
				</table>
			</fieldset>
		</div>
		<div class="content">
			<div class="infobox">
				Database utilities helper<br />This helper assumes the 'db' key is registered to an instance of
using the 'setInstance' method.<br />Parameters used by this class are sent directly as a part of the
generated SQL query. Only parameters that specifically says so are
escaped using the database escaping mechanism assigned to the
database registry instance.<br />Note that some drivers may not be fully supported, in paticular
SQLite is not supported by some of the table operational methods.
			</div>
			<br />
		</div>
		<div style="clear: left;"></div>
	</div>
</div>





<h2><span>Contents</span></h2>
<div class="box edge-title">
	<div class="inner">
		<div class="infobox">
			Table of contents
		</div>

		<h3>
	Properties
	<a name="properties"></a>
</h3>
<table style="width: 100%" cellspacing="2" cellpadding="0">
	<tr class="head">
		<td class="strong" nowrap="nowrap" style="width: 20%;">Property</td>
		<td class="strong">Description</td>
	</tr>
	<tr class="row">
	<td nowrap="nowrap"><a href="property-driver-011415.html">$driver</a></td>
	<td nowrap="nowrap" style="width: 100%">Database driver</td>
</tr><tr class="row">
	<td nowrap="nowrap"><a href="property-instance-473810.html">$instance</a></td>
	<td nowrap="nowrap" style="width: 100%">Database instance</td>
</tr>
</table><h3>
	Methods
	<a name="methods"></a>
</h3>
<table style="width: 100%" cellspacing="2" cellpadding="0">
	<tr class="head">
		<td class="strong" nowrap="nowrap" style="width: 20%;">Method</td>
		<td class="strong">Description</td>
	</tr>
	<tr class="row">
	<td nowrap="nowrap"><a href="method---construct-822630.html">__construct()</a></td>
	<td nowrap="nowrap" style="width: 100%">Constructs the database helper</td>
</tr><tr class="row">
	<td nowrap="nowrap"><a href="method-count-390368.html">count()</a></td>
	<td nowrap="nowrap" style="width: 100%">Counts the number of rows in a table</td>
</tr><tr class="row">
	<td nowrap="nowrap"><a href="method-getcolumns-449210.html">getColumns()</a></td>
	<td nowrap="nowrap" style="width: 100%">Gets all columns in from a table</td>
</tr><tr class="row">
	<td nowrap="nowrap"><a href="method-getdriver-144750.html">getDriver()</a></td>
	<td nowrap="nowrap" style="width: 100%">Gets the canonical driver name</td>
</tr><tr class="row">
	<td nowrap="nowrap"><a href="method-gettables-881378.html">getTables()</a></td>
	<td nowrap="nowrap" style="width: 100%">Gets all table within a database

Unsupported drivers are:</td>
</tr><tr class="row">
	<td nowrap="nowrap"><a href="method-setinstance-979431.html">setInstance()</a></td>
	<td nowrap="nowrap" style="width: 100%">Sets a new instance of a database object</td>
</tr><tr class="row">
	<td nowrap="nowrap"><a href="method-tableoptimize-733107.html">tableOptimize()</a></td>
	<td nowrap="nowrap" style="width: 100%">Table operation - optimize

Unsupported drivers are:</td>
</tr><tr class="row">
	<td nowrap="nowrap"><a href="method-tablerepair-092832.html">tableRepair()</a></td>
	<td nowrap="nowrap" style="width: 100%">Table operation - repair

Unsupported drivers are:</td>
</tr><tr class="row">
	<td nowrap="nowrap"><a href="method-truncate-930907.html">truncate()</a></td>
	<td nowrap="nowrap" style="width: 100%">Truncates a database table</td>
</tr>
</table>
	</div>
</div>







<h2><span>See also</span></h2>
<div class="box edge-title">
	<div class="inner">
		<ul>
			
			<li><a href="./classes.html">List of classes</a></li>
			<li><a href="./index.html">Table of contents</a></li>
		</ul>
	</div>
</div>

		<p>
			<em>Generated by Tuxxedo Engine 1.2.0 "Beloved" Beta 3 (experimental).</em>
		</p>
	</body>
</html>